Skip to content

Conversation

heckj
Copy link
Member

@heckj heckj commented Jun 16, 2025

fixes OpenAPI spec mismatches between require properties and available properties

resolves #1222

Summary

Updates the OpenAPI spec files for the outputs used in DocC archive to resolve warnings in mismatches between required fields and available properties defined in those fields

Updates:

  • LinkableEntities.json
  • RenderNode.spec.json

Dependencies

none

Testing

Manually verified the output doesn't present warnings when code generation is run with OpenAPI generator:

An example command:

git clone https://github.com/apple/swift-openapi-generator
cd swift-openapi-generator
swift run swift-openapi-generator generate --mode types --output-directory ~/foo /Users/joeheck/src/swift-docc/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@heckj heckj requested a review from franklinsch June 16, 2025 15:46
@heckj heckj self-assigned this Jun 16, 2025
@heckj
Copy link
Member Author

heckj commented Jun 16, 2025

@swift-ci please test

1 similar comment
@heckj
Copy link
Member Author

heckj commented Jul 12, 2025

@swift-ci please test

@heckj heckj force-pushed the rendernode-spec-fixes branch from 2316ca5 to 1e93cdc Compare August 20, 2025 22:46
@heckj
Copy link
Member Author

heckj commented Aug 20, 2025

@swift-ci please test

@heckj heckj requested a review from franklinsch August 20, 2025 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

required key in LinkableEntities schema not matched in property map
2 participants